/**
 * Copyright 2012 Brigham Young University
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package edu.byu.nlp.al;

import edu.byu.nlp.pipes.Instance;

public interface AnnotationRequest<L, D> {

	// FIXME : make into a proper singleton
	@SuppressWarnings("rawtypes")
	public static final AnnotationRequest ERROR_REQUEST = new AnnotationRequest() {

		/** {@inheritDoc} */
		@Override
		public long getAnnotatorId() {
			return -1;
		}

		/** {@inheritDoc} */
		@Override
		public Instance getInstance() {
			return null;
		}

		/** {@inheritDoc} */
		@Override
		public void cancelRequest() {
			throw new IllegalStateException();
		}

		/** {@inheritDoc} */
		@Override
		public boolean respond(Object annotation) {
			throw new IllegalStateException();
		}
		
	};
	
	long getAnnotatorId();
	Instance<L, D> getInstance();
	void cancelRequest();
	boolean storeAnnotation(L annotation);
}